/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Apache.Ignite;

using System.IO;
using System.Net.Security;
using System.Threading;
using System.Threading.Tasks;

/// <summary>
/// SSL Stream Factory defines how SSL connection is established.
/// <para />
/// See <see cref="IgniteClientConfiguration.SslStreamFactory"/>, <see cref="SslStreamFactory"/>.
/// </summary>
public interface ISslStreamFactory
{
    /// <summary>
    /// Creates the SSL stream.
    /// </summary>
    /// <param name="stream">The underlying raw stream.</param>
    /// <param name="targetHost">Target host.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>
    /// SSL stream, or null if SSL is not enabled.
    /// </returns>
    Task<SslStream?> CreateAsync(Stream stream, string targetHost, CancellationToken cancellationToken);
}
